feat: add Chronicle NativeDashboard resource by divyamjain000 · Pull Request #16735 · GoogleCloudPlatform/magic-modules

divyamjain000 · 2026-03-17T06:02:49Z

This PR introduces Terraform support for the Chronicle Native Dashboard resource by adding the google_chronicle_native_dashboard resource.

This includes:

Schema definition for the resource.
Create and Update functionalities.
Acceptance tests to cover the resource lifecycle.

Diffs for missing tests for "chart" properties will be ignored in a follow up PR due to its dependency on another resource hashicorp/terraform-provider-google#26521

Related Issue
Fixes hashicorp/terraform-provider-google#26483

Release Note Template for Downstream PRs (will be copied)

See Write release notes for guidance.

`google_chronicle_native_dashboard`

modular-magician · 2026-03-17T06:13:20Z

Hi there, I'm the Modular magician. I've detected the following information about your changes:

Diff report

Your PR generated some diffs in downstreams - here they are.

google provider: Diff ( 6 files changed, 1985 insertions(+), 2 deletions(-))
google-beta provider: Diff ( 6 files changed, 1985 insertions(+), 2 deletions(-))
terraform-google-conversion: Diff ( 1 file changed, 483 insertions(+))

Missing test report

Your PR includes resource fields which are not covered by any test.

Resource: google_chronicle_native_dashboard (3 total tests)
Please add an acceptance test which includes these fields. The test should include the following:

resource "google_chronicle_native_dashboard" "primary" {
  charts {
    chart_layout {
      span_x  = # value needed
      span_y  = # value needed
      start_x = # value needed
      start_y = # value needed
    }
    dashboard_chart = # value needed
    filters_ids     = # value needed
  }
  dashboard_id = # value needed
  filters {
    chart_ids    = # value needed
    is_mandatory = # value needed
  }
}

modular-magician · 2026-03-17T06:16:33Z

Tests analytics

Total tests: 27
Passed tests: 24
Skipped tests: 1
Affected tests: 2

Click here to see the affected service packages

Action taken

Found 2 affected test(s) by replaying old test recordings. Starting RECORDING based on the most recent commit. Click here to see the affected tests

Get to know how VCR tests work

modular-magician · 2026-03-17T06:17:13Z

🟢 Tests passed during RECORDING mode:
TestAccChronicleNativeDashboard_chronicleNativedashboardBasicExample [Debug log]
TestAccChronicleNativeDashboard_chronicleNativedashboardUpdateExample [Debug log]

🟢 No issues found for passed tests after REPLAYING rerun.

🟢 All tests passed!

View the build log or the debug log for each test

modular-magician · 2026-03-17T06:24:55Z

Hi there, I'm the Modular magician. I've detected the following information about your changes:

Diff report

Your PR generated some diffs in downstreams - here they are.

google provider: Diff ( 2 files changed, 406 insertions(+))
google-beta provider: Diff ( 6 files changed, 1977 insertions(+), 2 deletions(-))
terraform-google-conversion: Diff ( 1 file changed, 483 insertions(+))

Missing test report

Your PR includes resource fields which are not covered by any test.

Resource: google_chronicle_native_dashboard (1 total tests)
Please add an acceptance test which includes these fields. The test should include the following:

resource "google_chronicle_native_dashboard" "primary" {
  charts {
    chart_layout {
      span_x  = # value needed
      span_y  = # value needed
      start_x = # value needed
      start_y = # value needed
    }
    dashboard_chart = # value needed
    filters_ids     = # value needed
  }
  dashboard_id = # value needed
  filters {
    chart_ids    = # value needed
    field_path   = # value needed
    is_mandatory = # value needed
  }
  is_pinned = # value needed
}

modular-magician · 2026-03-17T06:28:26Z

Tests analytics

Total tests: 27
Passed tests: 25
Skipped tests: 1
Affected tests: 1

Click here to see the affected service packages

Action taken

Found 1 affected test(s) by replaying old test recordings. Starting RECORDING based on the most recent commit. Click here to see the affected tests

Get to know how VCR tests work

modular-magician · 2026-03-17T06:28:41Z

🔴 Tests failed during RECORDING mode:
TestAccChronicleNativeDashboard_chronicleNativedashboardBasicExample [Error message] [Debug log]

🔴 Errors occurred during RECORDING mode. Please fix them to complete your PR.

View the build log or the debug log for each test

modular-magician · 2026-03-17T06:30:22Z

Hi there, I'm the Modular magician. I've detected the following information about your changes:

Diff report

Your PR generated some diffs in downstreams - here they are.

google provider: Diff ( 2 files changed, 302 insertions(+))
google-beta provider: Diff ( 6 files changed, 1987 insertions(+), 2 deletions(-))
terraform-google-conversion: Diff ( 1 file changed, 483 insertions(+))

Missing test report

Your PR includes resource fields which are not covered by any test.

Resource: google_chronicle_native_dashboard (3 total tests)
Please add an acceptance test which includes these fields. The test should include the following:

resource "google_chronicle_native_dashboard" "primary" {
  charts {
    chart_layout {
      span_x  = # value needed
      span_y  = # value needed
      start_x = # value needed
      start_y = # value needed
    }
    dashboard_chart = # value needed
    filters_ids     = # value needed
  }
  dashboard_id = # value needed
  filters {
    chart_ids    = # value needed
    is_mandatory = # value needed
  }
}

modular-magician · 2026-03-17T06:33:37Z

Tests analytics

Total tests: 27
Passed tests: 25
Skipped tests: 1
Affected tests: 1

Click here to see the affected service packages

Action taken

Found 1 affected test(s) by replaying old test recordings. Starting RECORDING based on the most recent commit. Click here to see the affected tests

Get to know how VCR tests work

modular-magician · 2026-03-17T06:33:51Z

🔴 Tests failed during RECORDING mode:
TestAccChronicleNativeDashboard_chronicleNativedashboardBasicExample [Error message] [Debug log]

🔴 Errors occurred during RECORDING mode. Please fix them to complete your PR.

View the build log or the debug log for each test

modular-magician · 2026-03-17T07:04:45Z

Hi there, I'm the Modular magician. I've detected the following information about your changes:

Diff report

Your PR generated some diffs in downstreams - here they are.

google provider: Diff ( 2 files changed, 303 insertions(+))
google-beta provider: Diff ( 6 files changed, 1989 insertions(+), 2 deletions(-))
terraform-google-conversion: Diff ( 1 file changed, 483 insertions(+))

Missing test report

Your PR includes resource fields which are not covered by any test.

Resource: google_chronicle_native_dashboard (3 total tests)
Please add an acceptance test which includes these fields. The test should include the following:

resource "google_chronicle_native_dashboard" "primary" {
  charts {
    chart_layout {
      span_x  = # value needed
      span_y  = # value needed
      start_x = # value needed
      start_y = # value needed
    }
    dashboard_chart = # value needed
    filters_ids     = # value needed
  }
  dashboard_id = # value needed
  filters {
    chart_ids    = # value needed
    is_mandatory = # value needed
  }
}

modular-magician · 2026-03-17T07:08:04Z

Tests analytics

Total tests: 27
Passed tests: 26
Skipped tests: 1
Affected tests: 0

Click here to see the affected service packages

🟢 All tests passed!

View the build log

modular-magician · 2026-03-17T07:09:29Z

Hi there, I'm the Modular magician. I've detected the following information about your changes:

Diff report

Your PR generated some diffs in downstreams - here they are.

google provider: Diff ( 2 files changed, 303 insertions(+))
google-beta provider: Diff ( 6 files changed, 1989 insertions(+), 2 deletions(-))
terraform-google-conversion: Diff ( 1 file changed, 483 insertions(+))

Missing test report

Your PR includes resource fields which are not covered by any test.

Resource: google_chronicle_native_dashboard (3 total tests)
Please add an acceptance test which includes these fields. The test should include the following:

resource "google_chronicle_native_dashboard" "primary" {
  charts {
    chart_layout {
      span_x  = # value needed
      span_y  = # value needed
      start_x = # value needed
      start_y = # value needed
    }
    dashboard_chart = # value needed
    filters_ids     = # value needed
  }
  dashboard_id = # value needed
  filters {
    chart_ids    = # value needed
    is_mandatory = # value needed
  }
}

modular-magician · 2026-03-17T07:14:31Z

Tests analytics

Total tests: 27
Passed tests: 26
Skipped tests: 1
Affected tests: 0

Click here to see the affected service packages

🟢 All tests passed!

View the build log

github-actions · 2026-03-17T07:20:56Z

Googlers: For automatic test runs see go/terraform-auto-test-runs.

@slevenick, a repository maintainer, has been assigned to review your changes. If you have not received review feedback within 2 business days, please leave a comment on this PR asking them to take a look.

You can help make sure that review is quick by doing a self-review and by running impacted tests locally.

ankitgoyal0301 · 2026-03-17T10:16:29Z

mmv1/products/chronicle/NativeDashboard.yaml

+  api: 'https://cloud.google.com/chronicle/docs/reference/rest/v1beta/projects.locations.instances.nativeDashboards'
+base_url: projects/{{project}}/locations/{{location}}/instances/{{instance}}/nativeDashboards
+update_mask: true
+update_verb: PATCH


nit; Can we move these two down and keep all the links together for better readability?

ankitgoyal0301 · 2026-03-17T10:22:55Z

mmv1/products/chronicle/NativeDashboard.yaml

+    properties:
+      - name: charts
+        type: Array
+        ignore_read: true


Is there a specific reason for ignore_read: true on the charts property? I believe the dashboard definition is returned by the API on GET requests. If we ignore it on read, Terraform won't be able to detect drift if charts are modified outside of Terraform (e.g., via the UI). If the API response for this field is consistent, we should remove this to ensure full state management.

ankitgoyal0301 · 2026-03-17T10:25:50Z

mmv1/products/chronicle/NativeDashboard.yaml

+          properties:
+            - name: chartLayout
+              type: NestedObject
+              ignore_read: true


Similar to the charts array, why is ignore_read: true set for chartLayout? If the layout coordinates are returned by the API, they should be tracked in the state to allow users to manage the dashboard layout via Terraform.

ankitgoyal0301 · 2026-03-17T10:28:48Z

mmv1/products/chronicle/NativeDashboard.yaml

+
+examples:
+  - name: chronicle_nativedashboard_basic
+    primary_resource_id: my-basic-dashboard


nit; While not a blocker, using underscores consistently (e.g., my_basic_dashboard) aligns better with common Terraform practices.

ankitgoyal0301 · 2026-03-17T10:48:22Z

mmv1/products/chronicle/NativeDashboard.yaml

+    custom_flatten: 'templates/terraform/custom_flatten/id_from_name.tmpl'
+    description: The unique ID of the Dashboard.
+
+  - name: access


For both the access and type fields, consider changing the type from String to Enum and formally listing the enum_values. This allows Terraform to catch typos or invalid values locally before even making an API call, improving the user experience.

Are these values going to be expanded in the future? We tend to prefer strings is the set of values is mutable, but enums if it's relatively static. For example, if you're planning to add several other values here in the next few years, it tends to be easier for users if they don't have to upgrade provider versions to be able to use them

I've updated the properties to enum type that are very unlikely to be updated in the future and rest are kept as strings only.

Seems like the change hasn't been pushed to github, can you please check?

Yes, this has been updated and only the filterOperator values has been kept as ENUM.

mmv1/products/chronicle/NativeDashboard.yaml

slevenick · 2026-03-17T16:24:34Z

mmv1/products/chronicle/NativeDashboard.yaml

+    output: true
+    description: The full resource name of the dashboard.
+
+  - name: dashboardId


Is dashboardId not user-settable? It should be per https://google.aip.dev/133#user-specified-ids

No, this is set in the BE only.

slevenick · 2026-03-17T16:25:43Z

mmv1/products/chronicle/NativeDashboard.yaml

+    custom_flatten: 'templates/terraform/custom_flatten/id_from_name.tmpl'
+    description: The unique ID of the Dashboard.
+
+  - name: access


Are these values going to be expanded in the future? We tend to prefer strings is the set of values is mutable, but enums if it's relatively static. For example, if you're planning to add several other values here in the next few years, it tends to be easier for users if they don't have to upgrade provider versions to be able to use them

slevenick · 2026-03-17T16:26:04Z

mmv1/products/chronicle/NativeDashboard.yaml

+
+  - name: dashboardUserData
+    type: NestedObject
+    flatten_object: true


I don't think flatten object makes sense with an object with child fields

This one seems unnecessary. Removed flatten object.

slevenick · 2026-03-17T16:26:12Z

mmv1/products/chronicle/NativeDashboard.yaml

+
+  - name: definition
+    type: NestedObject
+    flatten_object: true


Again, why flatten object

Our BE expects the update mask to be more granular such as "definition.chartLayout" instead of only "definition. By flattening it, we can get the update mask at the child level.

modular-magician · 2026-03-20T04:35:52Z

Hi there, I'm the Modular magician. I've detected the following information about your changes:

Diff report

Your PR generated some diffs in downstreams - here they are.

google provider: Diff ( 2 files changed, 299 insertions(+))
google-beta provider: Diff ( 6 files changed, 1997 insertions(+), 2 deletions(-))
terraform-google-conversion: Diff ( 1 file changed, 483 insertions(+))

Missing test report

Your PR includes resource fields which are not covered by any test.

Resource: google_chronicle_native_dashboard (3 total tests)
Please add an acceptance test which includes these fields. The test should include the following:

resource "google_chronicle_native_dashboard" "primary" {
  charts {
    chart_layout {
      span_x  = # value needed
      span_y  = # value needed
      start_x = # value needed
      start_y = # value needed
    }
    dashboard_chart = # value needed
    filters_ids     = # value needed
  }
  filters {
    chart_ids    = # value needed
    is_mandatory = # value needed
  }
}

modular-magician · 2026-03-20T04:39:22Z

Tests analytics

Total tests: 27
Passed tests: 24
Skipped tests: 1
Affected tests: 2

Click here to see the affected service packages

Action taken

Found 2 affected test(s) by replaying old test recordings. Starting RECORDING based on the most recent commit. Click here to see the affected tests

Get to know how VCR tests work

modular-magician · 2026-03-20T04:40:03Z

🟢 Tests passed during RECORDING mode:
TestAccChronicleNativeDashboard_chronicleNativedashboardUpdateExample [Debug log]

🟢 No issues found for passed tests after REPLAYING rerun.

🔴 Tests failed during RECORDING mode:
TestAccChronicleNativeDashboard_chronicleNativedashboardBasicExample [Error message] [Debug log]

🔴 Errors occurred during RECORDING mode. Please fix them to complete your PR.

View the build log or the debug log for each test

modular-magician · 2026-03-20T05:25:04Z

Hi there, I'm the Modular magician. I've detected the following information about your changes:

Diff report

Your PR generated some diffs in downstreams - here they are.

google provider: Diff ( 2 files changed, 305 insertions(+))
google-beta provider: Diff ( 6 files changed, 2020 insertions(+), 2 deletions(-))
terraform-google-conversion: Diff ( 1 file changed, 493 insertions(+))

Missing test report

Your PR includes resource fields which are not covered by any test.

Resource: google_chronicle_native_dashboard (3 total tests)
Please add an acceptance test which includes these fields. The test should include the following:

resource "google_chronicle_native_dashboard" "primary" {
  charts {
    chart_layout {
      span_x  = # value needed
      span_y  = # value needed
      start_x = # value needed
      start_y = # value needed
    }
    dashboard_chart = # value needed
    filters_ids     = # value needed
  }
  filters {
    chart_ids    = # value needed
    is_mandatory = # value needed
  }
}

modular-magician · 2026-03-20T05:28:13Z

Tests analytics

Total tests: 27
Passed tests: 25
Skipped tests: 1
Affected tests: 1

Click here to see the affected service packages

Action taken

Found 1 affected test(s) by replaying old test recordings. Starting RECORDING based on the most recent commit. Click here to see the affected tests

Get to know how VCR tests work

modular-magician · 2026-03-20T05:28:52Z

🟢 Tests passed during RECORDING mode:
TestAccChronicleNativeDashboard_chronicleNativedashboardBasicExample [Debug log]

🟢 No issues found for passed tests after REPLAYING rerun.

🟢 All tests passed!

View the build log or the debug log for each test

mmv1/products/chronicle/NativeDashboard.yaml

ankitgoyal0301 · 2026-03-20T06:11:43Z

mmv1/products/chronicle/NativeDashboard.yaml

+      sent on update and delete requests.
+
+  - name: type
+    type: String


Same ENUM comment.

divyamjain000 force-pushed the chronicle-nativedashboard-divyamjain branch from 0b78cb2 to f54a9c4 Compare March 17, 2026 06:11

modular-magician added the service/chronicle label Mar 17, 2026

modular-magician requested a review from ankitgoyal0301 March 17, 2026 06:13

divyamjain000 force-pushed the chronicle-nativedashboard-divyamjain branch from f54a9c4 to 1a124be Compare March 17, 2026 06:19

divyamjain000 force-pushed the chronicle-nativedashboard-divyamjain branch 2 times, most recently from f9002f0 to d4db073 Compare March 17, 2026 06:54

divyamjain000 mentioned this pull request Mar 17, 2026

feat: add Chronicle DashboardChart resources #16734

Draft

divyamjain000 marked this pull request as ready for review March 17, 2026 07:20

github-actions bot requested a review from slevenick March 17, 2026 07:20

ankitgoyal0301 reviewed Mar 17, 2026

View reviewed changes

mmv1/products/chronicle/NativeDashboard.yaml Show resolved Hide resolved

ankitgoyal0301 suggested changes Mar 17, 2026

View reviewed changes

slevenick reviewed Mar 17, 2026

View reviewed changes

divyamjain000 force-pushed the chronicle-nativedashboard-divyamjain branch from d4db073 to a1e0eb3 Compare March 20, 2026 04:24

github-actions bot requested a review from slevenick March 20, 2026 04:24

modular-magician requested a review from ankitgoyal0301 March 20, 2026 04:36

feat: add Chronicle NativeDashboard resource

6867ce7

divyamjain000 force-pushed the chronicle-nativedashboard-divyamjain branch from a1e0eb3 to 6867ce7 Compare March 20, 2026 05:14

ankitgoyal0301 reviewed Mar 20, 2026

View reviewed changes

mmv1/products/chronicle/NativeDashboard.yaml Show resolved Hide resolved

ankitgoyal0301 reviewed Mar 20, 2026

View reviewed changes

ankitgoyal0301 suggested changes Mar 20, 2026

View reviewed changes

Conversation

divyamjain000 commented Mar 17, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

modular-magician commented Mar 17, 2026

Diff report

Missing test report

Uh oh!

modular-magician commented Mar 17, 2026

Tests analytics

Action taken

Uh oh!

modular-magician commented Mar 17, 2026

Uh oh!

modular-magician commented Mar 17, 2026

Diff report

Missing test report

Uh oh!

modular-magician commented Mar 17, 2026

Tests analytics

Action taken

Uh oh!

modular-magician commented Mar 17, 2026

Uh oh!

modular-magician commented Mar 17, 2026

Diff report

Missing test report

Uh oh!

modular-magician commented Mar 17, 2026

Tests analytics

Action taken

Uh oh!

modular-magician commented Mar 17, 2026

Uh oh!

modular-magician commented Mar 17, 2026

Diff report

Missing test report

Uh oh!

modular-magician commented Mar 17, 2026

Tests analytics

Uh oh!

modular-magician commented Mar 17, 2026

Diff report

Missing test report

Uh oh!

modular-magician commented Mar 17, 2026

Tests analytics

Uh oh!

github-actions bot commented Mar 17, 2026

Uh oh!

ankitgoyal0301 Mar 17, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

divyamjain000 commented Mar 17, 2026 •

edited

Loading

ankitgoyal0301 Mar 17, 2026 •

edited

Loading